###使用React,Redux和reudx-saga构建一个图像浏览程序(翻译)
Joel Hooks ,2016年3月
#####构建一个图片长廊
图像长廊是一个简单的程序，从Flicker API 加载图片urls,允许用户查看图片详情。
图片1
后续会使用React,Redux和redux-saga.React作为核心框架，优势是虚拟dom(virtual-dom)的实现。Redux在程序内负责state的管理。最后，我们会使用redux-saga来操作javascript的异步操作步骤。
我会是用ES6(箭头函数，模块，和模板字符串)，所以我们首先需要做一些项目的配置工作。
项目配置和自动化
如果要开始一个React项目，须有有一系列的配置选项。对于一个简单的项目，我想把配置选项尽可能缩减。考虑到浏览器的版本问题，我会使用Babel把ES6编译为ES5。后面这一句不懂
首先使用npm init 创建一个package.json文件
package.json
1 | { |
有了package.json, 可以在项目文件夹命令行运行 npm install 安装程序需要的依赖项。
.babelrc
1 | { |
<!doctype html>
Egghead Image Gallery
1 | ___ |
import "babel-polyfill"
import React from ‘react’
import ReactDOM from ‘react-dom’
ReactDOM.render(
Hello React!
,document.getElementById(‘root’)
);
1 |
|
body {
font-family: Helvetica, Arial, Sans-Serif, sans-serif;
background: white;
}
.title {
display: flex;
padding: 2px;
}
.egghead {
width: 30px;
padding: 5px;
}
.image-gallery {
width: 300px;
display: flex;
flex-direction: column;
border: 1px solid darkgray;
}
.gallery-image {
height: 250px;
display: flex;
align-items: center;
justify-content: center;
}
.gallery-image img {
width: 100%;
max-height: 250px;
}
.image-scroller {
display: flex;
justify-content: space-around;
overflow: auto;
overflow-y: hidden;
}
.image-scroller img {
width: 50px;
height: 50px;
padding: 1px;
border: 1px solid black;
}
1 |
|
import React, {Component} from 'react'
const flickrImages = [
“https://farm2.staticflickr.com/1553/25266806624_fdd55cecbc.jpg",
“https://farm2.staticflickr.com/1581/25283151224_50f8da511e.jpg",
“https://farm2.staticflickr.com/1653/25265109363_f204ea7b54.jpg",
“https://farm2.staticflickr.com/1571/25911417225_a74c8041b0.jpg",
“https://farm2.staticflickr.com/1450/25888412766_44745cbca3.jpg"
];
export default class Gallery extends Component {
constructor(props) {
super(props);
this.state = {
images: flickrImages,
selectedImage: flickrImages[0]
}
}
render() {
const {images, selectedImage} = this.state;
return (
{images.map((image, index) => (
))}
)
}
}
1 |
|
import "babel-polyfill"
import React from ‘react’
import ReactDOM from ‘react-dom’
- import Gallery from ‘./Gallery’
ReactDOM.render(
Hello React!
,
,
document.getElementById(‘root’)
);1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
到现在，我们使用硬编码的图片URLs(通过fickrImages)数组,第一张图片作为`selectedImage`.这些属性在`Gallery`组件的构造函数缺省配置中，通过初始状态(initial)来设定.
图片3
接下来在组件中添加一个和组件进行交互操作的方法，方法具体内容是操做`setSate`.
`Gallery.js`
```js
export default class Gallery extends Component {
constructor(props) {
super(props);
this.state = {
images: flickrImages,
selectedImage: flickrImages[0]
}
}
+ handleThumbClick(selectedImage) {
+ this.setState({
+ selectedImage
+ })
+ }
render() {
const {images, selectedImage} = this.state;
return (
<div className="image-gallery">
<div className="gallery-image">
<div>
<img src={selectedImage} />
</div>
</div>
<div className="image-scroller">
{images.map((image, index) => (
- <div key={index}>
+ <div key={index} onClick={this.handleThumbClick.bind(this,image)}>
<img src={image}/>
</div>
))}
</div>
</div>
)
}
}
在Gallery组件添加handleThumbClick方法,任何元素都可用通过onClick属性调用这个方法.image作为第二个参数传递，元素自身作为第一个参数传递.bind方法传递javascript函数调用上下文对象是非常便捷。
看起来错!现在我们有了一些交互操作，有点“APP”的意思了。截止目前，我们已经让app运行起来了，接下来要考虑加载远程数据。最容易加载远程数据的地方是一个React组件生命周期方法,我们使用componentDidMount方法,通过他从Flikr API请求并加载一些图片.
Gallery.js
1 | export default class Gallery extends Component { |
我们在Gallery类中添加了一个新的方法,通过React的componentDidMount生命周期方法触发Flickr图片数据的获取。
在React组件运行的不同时间点，组件会调用不同的生命周期函数。在这段代码中，当组件被渲染到DOM中的时间点,componentDidMount函数就会被调用。需要注意的是:Gallery组件只有一次渲染到DOM的机会，所以这个函数可以提供一些初始化图片.考虑到在APP的整个生命周期中,有更多的动态组件的加载和卸载,这可能会造成一些多余的调用和无法考虑到的结果。
我们使用浏览器接口(browser API)的fetch方法执行请求.Fetch返回一个promise对象解析response对象.调用response.json()方法,返回另一个promise对象，这就是我们实际需要的json格式的数据.遍历这个对象以后就可以获取图片的url地址.
坦白讲，这个应用很简单.我们还需要在这里花费更多的时间，还有一些基础的需求需要完成.或许我们应该在promise处理流程中添加错误处理方法,如果图片数据获取成功也需要一些处理逻辑.在这个地方，你需要发挥一些想象力.在生产实践中简单的需求是很少见的.很快,应用中就会添加更多的需求。认证,滚动橱窗,加载不同图片库的能力和图片的设置等等.仅仅这些还还不够.
我们已经使用React构建了一个加载图片库的程序。接下来我们需要考虑到随着程序功能的添加，到底需要哪些基础的模式.首先考虑到的一个问题就是要把应用的状态(state)控制从Gallery组件中分离出来.
我们通过引入Redux来完成应用的状态管理工作。
使用Redux来管理状态
在你的应用中只要使用了setState方法都会让一个组件从无状态变为有状态的组件.糟糕的是这个方法会导致应用中出现一些令人困惑的代码,这些代码会在应用中到处蔓延。
Flux构架来减轻这个问题.Flux把逻辑(logic)和状态(state)迁移到Store中.应用中的动作(Actions)被Dispatch的时候,Stores
会做相应的更新.Stores的更新会触发View根据新状态的渲染.
那么我们为什么要舍弃Flux?他竟然还是“官方”构建的.
好吧！Redux是基于Flux构架的,但是他有一些独特的优势.下面是Dan Abramov(Redux创建者)的一些话：
Redux和Flux没有什么不同.总体来讲他们是相同的构架,但是Redux通过功能组合把Flux使用回调注册的复杂点给屏蔽掉了.
两个构架从更本上讲没有什么不同，但是我发现Redux使一些在Flux比较难实现的逻辑更容易实现.
Redux文档非常棒.Dan(这句话不知道怎么翻译了)
如果你还没有读过代码的卡通教程或者Dan的系列文章.赶快去看看吧！
###启动Redux
第一件需要做的事事初始化Redux,让他在我们的程序中运行起来.现在不需要做安装工作，刚开始运行npm install的时候已经安装好了依赖项，我们需要做一些导入和配置工作.
reducer函数是Redux的大脑. 每当应用分发(或派遣,dispatch)一个操作(action)的时候,reducer函数会接受操作(action)并且依据这个动作(action)创建reducer自己的state.因为reducers是纯函数，他们可以组合到一起，创建应用的一个完整state.让我们在src中创建一个简单的reducer:
reducer.js
1 | export default function images(state, action) { |
一个reducer函数接受两个参数(arguments).
- [x]
state-这个数据代表应用的状态(state).reducer函数使用这个状态来构建一个reducer自己可以管理的状态.如果状态没有发生改变,reducer会返回输入的状态. - [x]
action-这是触发reducer的事件.Actions通过store派发(dispatch),由reducer处理.action需要一个type属性来告诉reducer怎么处理state.
目前,images reuducer在终端中打印出日志记录，表明工作流程是正常的，可以做接下来的工作了.为了使用reducer，需要在main.js中做一些配置工作:main.js
1 | import "babel-polyfill"; |
我们从Redux库中导入createStore组件.creatStore用来创建Redux的store.大多数情况下,我们不会和store直接交互,store在Redux中做幕后管理工作.
也需要导入刚才创建的reducer函数,以便于他可以被发送到store.
我们将通过createStore(reducer)操作，利用reducer来配置应用的store.这个示例仅仅只有一个reducer,但是createStore可以接收多个reducer作为参数.稍后我们会看到这一点.
最后我们导入高度集成化的组件Provider,这个组件用来包装Gallery,以便于我们在应用中使用Redux.我们需要把刚刚创建的store传递给Provider.你也可以不使用Provider,实际上Redux可以不需要React.但是我们将会使用Provider,因为他非常便于使用.
图3
这张图可能有点古怪，但是展示了Redux的一个有意思的地方.所有的reducers接收在应用中的全部actions(动作或操作).在这个例子中我们可以看到Redux自己派发的一个action.
连接Gallery组件
借助Redux,我们将使用”connected”和“un-connected”组件.一个connected组件被连线到store.connected组件使控制动作事件(controls action event)和store协作起来.通常,一个connected组件有子组件,子组件具有单纯的接收输入和渲染功能，当数据更新时执行调用.这个子组件就是unconnected组件.
提示:当Rect和Redux配合是工作的非常好,但是Redux不是非要和React在一起才能工作.没有React,Redux其实可以和其他框架配合使用.
在应用中需要关联React组件和Redux Store 的时候，react-redux提供了便捷的包装器.我们把react-redux添加进Gallery中
,从而使Gallery成为首要的关联组件.
Gallery.js
1 | import React, {Component} from 'react' |
从react-redux导入connect函数,可以在导出组件的时候把他变为链接组件(connected component).请注意,connect()(Gallery)代码把Gallery组件放在第二个形参中,这是因为connect()返回一个函数，这个函数接受一个React组件作为参数(argument).调用connect()函数时需要配置项.后面我们将会传递配置我们应用的actions和state参数.
我们也把connect作为默认配置到处模块.这一点非常重要！现在当我们import Gallery的时候,就不是一个单纯的React组件了,而是一个和Redux关联的组件了.
图4
如果你观察我们添加进构造器的console.log的输出,就可以看到Gallery组件的属性现在包括了一个dispatch函数.这个地方是connect为我们的应用修改的,这个改动赋予了组件把自己的动作对象(action objects)派发到reducers的能力.
1 | export class Gallery extends Component { |
我们可以在组件的构造器中调用派发功能.你可以在开发者的终端中看到来自reducer的日志声明.看到声明表示我们已经派发了第一个action!.Actions是一个单一的javascript对象,必需有type属性.Actions可以拥有任意数量和种类的其他属性.但是type可以让reducers理解这些动作到底是做什么用的(意译，意思是只有拥有type属性，reducers才知道对state做什么样的修改).
1 | export default function images(state, action) { |
总的reducers使用switch代码块过滤有关的消息,Switch语句使用actions的type属性,当一个action和case分支吻合以后,相应的单个reducer就会执行他的具体工作.
我们的应用现在关联到接收的动作.现在我们需要把Redux-Store提供的state关联到应用中.
默认的应用状态(state)
reducer.js
1 | const defaultState = { |
我们创建一个defaultState对象,这个对象返回一个空数组作为images的属性.我们把images函数的参数state设置为默认.如果在test分支中输出日志,将会看到state不是undefined(空数组不是undefined)!reducer需要返回应用的当前state.这点很重要!现在我们没有做任何改变,所以仅仅返回state.注意我们在case中添加了default分支,reducer必须要返回一个state.
在Gallery组件中，我们也可以把state做一定的映射(map)以后再连接到应用.
1 | import React, {Component} from 'react' |
const defaultState = {
- images: []
- images: [
- “https://farm2.staticflickr.com/1553/25266806624_fdd55cecbc.jpg",
- “https://farm2.staticflickr.com/1581/25283151224_50f8da511e.jpg",
- “https://farm2.staticflickr.com/1653/25265109363_f204ea7b54.jpg",
- “https://farm2.staticflickr.com/1571/25911417225_a74c8041b0.jpg",
- “https://farm2.staticflickr.com/1450/25888412766_44745cbca3.jpg"
- ],
- selectedImage: “https://farm2.staticflickr.com/1553/25266806624_fdd55cecbc.jpg"
}
export default function images(state = defaultState, action) {
switch(action.type) {
case ‘TEST’:
console.log(state, action)
return state;
default:
return state;
}
}
1 |
|
const defaultState = {
images: [
“https://farm2.staticflickr.com/1553/25266806624_fdd55cecbc.jpg",
“https://farm2.staticflickr.com/1581/25283151224_50f8da511e.jpg",
“https://farm2.staticflickr.com/1653/25265109363_f204ea7b54.jpg",
“https://farm2.staticflickr.com/1571/25911417225_a74c8041b0.jpg",
“https://farm2.staticflickr.com/1450/25888412766_44745cbca3.jpg"
],
selectedImage: “https://farm2.staticflickr.com/1553/25266806624_fdd55cecbc.jpg"
}
export default function images(state = defaultState, action) {
switch(action.type) {
- case ‘TEST’:
case ‘IMAGE_SELECTED’: - return state;
return {…state, selectedImage: action.image};
default:
return state;
}
}1
2
现在reducer已经准备接收`IMAGE_SELECTED` action了.在`IMAGE_SELECTED`分支选项内,我们在展开(spreading,ES6的对象操作方法),并重写`selectedImage`属性后,返回一个新state对象.了解更多的`...state`对象操作可以看`ruanyifeng`的书.import React, {Component} from ‘react’
import {connect} from ‘react-redux’;
export class Gallery extends Component {
- constructor(props) {
- super(props);
- this.props.dispatch({type: ‘TEST’});
- console.log(props);
- }
render() { - const {images, selectedImage} = this.props;
const {images, selectedImage, dispatch} = this.props;
return (
<div> <img src={selectedImage} /> </div>
{images.map((image, index) => (
- dispatch({type:’IMAGE_SELECTED’, image})}>
))}
)
}
}
function mapStateToProps(state) {
return {
images: state.images,
selectedImage: state.selectedImage
}
}
export default connect(mapStateToProps)(Gallery)
1 |
|
export const IMAGE_SELECTED = ‘IMAGE_SELECTED’;
export function selectImage(image) {
return {
type: IMAGE_SELECTED,
image
}
}
1 |
|
import * as GalleryActions from ‘./actions.js’;
[…]
onClick={() => dispatch(GalleryActions.selectImage(image))}
1 |
|
import React, {Component} from ‘react’
import {connect} from ‘react-redux’;
import {bindActionCreators} from ‘redux’;
import * as GalleryActions from ‘./actions.js’;
export class Gallery extends Component {
constructor(props) {
super(props);
this.props.dispatch({type: ‘TEST’});
console.log(props);
}
handleThumbClick(selectedImage) {
this.setState({
selectedImage
})
}
render() {
- const {images, selectedImage, dispatch} = this.props;
- const {images, selectedImage, selectImage} = this.props;
return (
<div> <img src={selectedImage} /> </div>
{images.map((image, index) => (
- dispatch({type:’IMAGE_SELECTED’, image})}>
- selectImage(image)}>
))}
)
}
}
function mapStateToProps(state) {
return {
images: state.images,
selectedImage: state.selectedImage
}
}
+function mapActionCreatorsToProps(dispatch) {
- return bindActionCreators(GalleryActions, dispatch);
+}
-export default connect(mapStateToProps)(Gallery)
+export default connect(mapStateToProps, mapActionCreatorsToProps)(Gallery)
1 |
|
export function* loadImages() {
try {
const images = yield call(fetchImages);
yield put({type: ‘IMAGES_LOADED’, images})
yield put({type: ‘IMAGE_SELECTED’, image: images[0]})
} catch(error) {
yield put({type: ‘IMAGE_LOAD_FAILURE’, error})
}
}
export function* watchForLoadImages() {
while(true) {
yield take(‘LOAD_IMAGES’);
yield call(loadImages);
}
}
1 |
|
export function* sayHello() {
console.log(‘hello’);
}
1 |
|
import “babel-polyfill”;
import React from ‘react’;
import ReactDOM from ‘react-dom’;
import Gallery from ‘./Gallery’;
import { createStore } from ‘redux’
import {Provider} from ‘react-redux’;
import reducer from ‘./reducer’
+import {sayHello} from ‘./sagas’;
+sayHello();
const store = createStore(reducer);
ReactDOM.render(
document.getElementById(‘root’)
);1
2
3
4
5
6
不管你盯住终端多长时间,“hello”永远不会出现.
这是因为`sayHello`是一个generator！Generator 不会立即执行.如果你把代码该为`sayHello().next();`你的“hello”就出现了.不用担心,我们不会总是调用`next`.正如Redux,redux-saga用来消除应用开发中的痛苦.
配置 redux-sage
import “babel-polyfill”;
import React from ‘react’;
import ReactDOM from ‘react-dom’;
import Gallery from ‘./Gallery’;
-import { createStore } from ‘redux’
+import { createStore, applyMiddleware } from ‘redux’
+import createSagaMiddleware from ‘redux-saga’
import {Provider} from ‘react-redux’;
import reducer from ‘./reducer’
import {sayHello} from ‘./sagas’;
-sayHello()
-const store = createStore(reducer);
+const store = createStore(
- reducer,
- applyMiddleware(createSagaMiddleware(sayHello))
+);
ReactDOM.render(
document.getElementById(‘root’)
);
1 |
|
-export function* sayHello() {
- console.log(‘hello’);
-}
+export function* loadImages() {
- console.log(‘load some images please’)
+}1
2
不要忘了更新`main.js`
import “babel-polyfill”;
import React from ‘react’;
import ReactDOM from ‘react-dom’;
import Gallery from ‘./Gallery’;
import { createStore, applyMiddleware } from ‘redux’
import {Provider} from ‘react-redux’;
import createSagaMiddleware from ‘redux-saga’
import reducer from ‘./reducer’
-import {sayHello} from ‘./sagas’;
+import {loadImages} from ‘./sagas’;
const store = createStore(
reducer,
- applyMiddleware(createSagaMiddleware(sayHello))
- applyMiddleware(createSagaMiddleware(loadImages))
);
ReactDOM.render(
document.getElementById(‘root’)
);
1 |
|
const API_KEY = 'a46a979f39c49975dbdd23b378e6d3d5';
const API_ENDPOINT = https://api.flickr.com/services/rest/?method=flickr.interestingness.getList&api_key=${API_KEY}&format=json&nojsoncallback=1&per_page=5;
const fetchImages = () => {
return fetch(API_ENDPOINT).then(function (response) {
return response.json().then(function (json) {
return json.photos.photo.map(
({farm, server, id, secret}) => https://farm${farm}.staticflickr.com/${server}/${id}_${secret}.jpg
);
})
})
};
export function* loadImages() {
const images = yield fetchImages();
console.log(images)
}1
2
3
4
5
6
7
8
9
`fetchImages`方法返回一个promise对象.我们将调用`fetchImages`,但是现在我们要使用`yield`关键字.通过黑暗艺术和巫术,generators理解Promise对象,正如终端输出的日志显示,我们已经收获了一个图片URLs的数组.看看`loadImages`的代码,他看起来像是典型的同步操作代码.`yield`关键字是秘制调味酱,让我们的代码用同步格式执行异步操作活动.
#### 封装我们的异步API请求.
首先来定义一下需要使用的api.他没有什么特殊的地方,实际上他和早先加载Flickr images的代码是相同的.我们创建`flickr.js`文件
const API_KEY = ‘a46a979f39c49975dbdd23b378e6d3d5’;
const API_ENDPOINT = https://api.flickr.com/services/rest/?method=flickr.interestingness.getList&api_key=${API_KEY}&format=json&nojsoncallback=1&per_page=5;
export const fetchImages = () => {
return fetch(API_ENDPOINT).then(function (response) {
return response.json().then(function (json) {
return json.photos.photo.map(
({farm, server, id, secret}) => https://farm${farm}.staticflickr.com/${server}/${id}_${secret}.jpg
);
})
})
};1
2
3
4
5
6
严格意义上来说,不需要这么做,但是这会带来一定的好处.我们处在应用的边缘(boundaries of our application,意思是说在这里的代码可能是很多和远程服务器交互的代码，可能逻辑会很复杂),事情都有点乱.通过封装和远程API交互的逻辑,我们的代码将会很整洁,很容易更新.如果需要抹掉图片服务也会出奇的简单.
我们的`saga.js`看起来是这个样子：
import {fetchImages} from ‘./flickr’;
export function* loadImages() {
const images = yield fetchImages();
console.log(images)
}
1 |
|
const defaultState = {
- images: []
}
export default function images(state = defaultState, action) {
switch(action.type) {
case ‘IMAGE_SELECTED’:
return {…state, selectedImage: action.image};
- case ‘IMAGES_LOADED’:
return {…state, images: action.images};
default:
return state;
}
}1
2
3
4
我们添加了新的分支,并从`defaultState`中删除了硬编码的URLs数据.`IMAGES_LOADED`分支现在返回一个更新的state,包含action的image数据.
下一步我们更新saga:import {fetchImages} from ‘./flickr’;
+import {put} from ‘redux-saga/effects’;
export function* loadImages() {
const images = yield fetchImages();
yield put({type: ‘IMAGES_LOADED’, images})
}1
2
3
4
5
6
7导入`put`以后,我们在`loadImages`添加另外一行.他`yield` `put`函数调用的返回结果.在幕后,redux-saga 分发这些动作,reducer接收到了消息!
怎样才能使用特定类型的action来触发一个saga?
#### 使用actions来触发saga工作流
Sagas变得越来越有用,因为我们有能力使用redux actions来触发工作流.当我们这样做,saga会在我们的应用中表现出更大的能力.首先我们创建一个新的saga.`watchForLoadImages`.import {fetchImages} from ‘./flickr’;
-import {put} from ‘redux-saga/effects’;
+import {put, take} from ‘redux-saga/effects’;
export function* loadImages() {
const images = yield fetchImages();
yield put({type: ‘IMAGES_LOADED’, images})
}
+export function* watchForLoadImages() {
- while(true) {
- yield take(‘LOAD_IMAGES’);
- yield loadImages();
}
+}`这个新saga使用
while循环,因此他总是处于激活和等待状态.